| Package | openehr.base |
| Type | StructureDefinition |
| Id | Id |
| FHIR Version | R5 |
| Source | http://openehr.org/fhir/https://build.fhir.org/ig/FHIR/openehr-base-ig/StructureDefinition-CODE-PHRASE.html |
| Url | http://openehr.org/fhir/StructureDefinition/CODE-PHRASE |
| Version | 0.1.0 |
| Status | active |
| Date | 2023-06-27T18:45:58+10:00 |
| Name | CODE_PHRASE |
| Title | CODE_PHRASE |
| Experimental | False |
| Realm | uv |
| Authority | hl7 |
| Description | A fully coordinated (i.e. all coordination has been performed) term from a terminology service (as distinct from a particular terminology). |
| Type | http://openehr.org/fhir/StructureDefinition/CODE_PHRASE |
| Kind | logical |
| StructureDefinition | |
AUTHORED-RESOURCE  | AUTHORED_RESOURCE |
| COMPOSITION | COMPOSITION |
| DV-CODED-TEXT | DV_CODED_TEXT |
| DV-ENCAPSULATED | DV_ENCAPSULATED |
| DV-MULTIMEDIA | DV_MULTIMEDIA |
| DV-ORDERED | DV_ORDERED |
| DV-TEXT | DV_TEXT |
| ENTRY | ENTRY |
| RESOURCE-DESCRIPTION-ITEM | RESOURCE_DESCRIPTION_ITEM |
| TERM-MAPPING | TERM_MAPPING |
| TRANSLATION-DETAILS | TRANSLATION_DETAILS |
| StructureDefinition | |
| TERMINOLOGY-ID | TERMINOLOGY_ID |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition CODE-PHRASE
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  CODE_PHRASE | 0..* | Base | A fully coordinated (i.e. all coordination has been performed) term from a terminology service Instances of this logical model are not marked to be the target of a Reference | |
  terminology_id | 1..1 | TERMINOLOGY_ID | Identifier of the distinct terminology from which the code_string was extracted | |
 code_string | 1..1 | string | The key used by the terminology service to identify a concept or coordination of concepts | |
 preferred_term | 0..1 | string | Optional attribute to carry preferred term corresponding to the code or expression in code_string | |
| Documentation for this format | ||||
FHIR{
"resourceType" : "StructureDefinition",
"id" : "CODE-PHRASE",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: StructureDefinition CODE-PHRASE</b></p><a name=\"CODE-PHRASE\"> </a><a name=\"hcCODE-PHRASE\"> </a><a name=\"CODE-PHRASE-en-US\"> </a><table border=\"0\" fhir=\"generated-heirarchy\" cellpadding=\"0\" cellspacing=\"0\" style=\"border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;\"><tr fhir=\"generated-heirarchy\" style=\"border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top\"><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"The logical name of the element\">Name</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Information about the use of the element\">Flags</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Minimum and Maximum # of times the element can appear in the instance\">Card.</a></th><th style=\"width: 100px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Reference to the type of the element\">Type</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Additional information about the element\">Description & Constraints</a><span style=\"float: right\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC\" alt=\"doco\" style=\"background-color: inherit\"/></a></span></th></tr><tr fhir=\"generated-heirarchy\" style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-CODE-PHRASE-definitions.html#CODE_PHRASE\" title=\"A fully coordinated (i.e. all coordination has been performed) term from a terminology service (as distinct from a particular terminology).\">CODE_PHRASE</a><a name=\"CODE_PHRASE\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..*</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R5/types.html#Base\">Base</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">A fully coordinated (i.e. all coordination has been performed) term from a terminology service<br/><span style=\"font-weight:bold\">Instances of this logical model are not marked to be the target of a Reference</span><br/></td></tr>\r\n<tr fhir=\"generated-heirarchy\" style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_resource.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Resource\" class=\"hierarchy\"/> <a href=\"StructureDefinition-CODE-PHRASE-definitions.html#CODE_PHRASE.terminology-id\" title=\"Identifier of the distinct terminology from which the code_string (or its elements) was extracted.\">terminology_id</a><a name=\"CODE_PHRASE.terminology_id\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-TERMINOLOGY-ID.html\">TERMINOLOGY_ID</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Identifier of the distinct terminology from which the code_string was extracted</td></tr>\r\n<tr fhir=\"generated-heirarchy\" style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-CODE-PHRASE-definitions.html#CODE_PHRASE.code-string\" title=\"The key used by the terminology service to identify a concept or coordination of concepts. This string is most likely parsable inside the terminology service, but nothing can be assumed about its syntax outside that context.\">code_string</a><a name=\"CODE_PHRASE.code_string\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R5/datatypes.html#string\">string</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The key used by the terminology service to identify a concept or coordination of concepts</td></tr>\r\n<tr fhir=\"generated-heirarchy\" style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck00.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-CODE-PHRASE-definitions.html#CODE_PHRASE.preferred-term\" title=\"Optional attribute to carry preferred term corresponding to the code or expression in code_string. Typical use in integration situations which create mappings, and representing data for which both a (non-preferred) actual term and a preferred term are both required.\">preferred_term</a><a name=\"CODE_PHRASE.preferred_term\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R5/datatypes.html#string\">string</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Optional attribute to carry preferred term corresponding to the code or expression in code_string</td></tr>\r\n<tr fhir=\"generated-heirarchy\"><td colspan=\"5\" class=\"hierarchy\"><br/><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC\" alt=\"doco\" style=\"background-color: inherit\"/> Documentation for this format</a></td></tr></table></div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/web-source",
"valueUrl" : "https://specifications.openehr.org/releases/RM/Release-1.1.0/data_types.html#_code_phrase_class"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode" : "can-bind"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 3,
"_valueInteger" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical" : "http://openehr.org/fhir/ImplementationGuide/openehr.base"
}
]
}
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "informative",
"_valueCode" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical" : "http://openehr.org/fhir/ImplementationGuide/openehr.base"
}
]
}
}
],
"url" : "http://openehr.org/fhir/StructureDefinition/CODE-PHRASE",
"version" : "0.1.0",
"name" : "CODE_PHRASE",
"title" : "CODE_PHRASE",
"status" : "active",
"experimental" : false,
"date" : "2023-06-27T18:45:58+10:00",
"publisher" : "openEHR + HL7",
"contact" : [
{
"telecom" : [
{
"system" : "url",
"value" : "http://www.openehr.org"
}
]
}
],
"description" : "A fully coordinated (i.e. all coordination has been performed) term from a terminology service (as distinct from a particular terminology).",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001"
}
]
}
],
"fhirVersion" : "5.0.0",
"mapping" : [
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}
],
"kind" : "logical",
"abstract" : false,
"type" : "http://openehr.org/fhir/StructureDefinition/CODE_PHRASE",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Base",
"derivation" : "specialization",
"snapshot" : {
"element" : [
{
"id" : "CODE_PHRASE",
"path" : "CODE_PHRASE",
"short" : "A fully coordinated (i.e. all coordination has been performed) term from a terminology service",
"definition" : "A fully coordinated (i.e. all coordination has been performed) term from a terminology service (as distinct from a particular terminology).",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Base",
"min" : 0,
"max" : "*"
},
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "CODE_PHRASE.terminology-id",
"path" : "CODE_PHRASE.terminology_id",
"short" : "Identifier of the distinct terminology from which the code_string was extracted",
"definition" : "Identifier of the distinct terminology from which the code_string (or its elements) was extracted.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CODE_PHRASE.terminology_id",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/TERMINOLOGY-ID"
}
],
"isModifier" : false
},
{
"id" : "CODE_PHRASE.code-string",
"path" : "CODE_PHRASE.code_string",
"short" : "The key used by the terminology service to identify a concept or coordination of concepts",
"definition" : "The key used by the terminology service to identify a concept or coordination of concepts. This string is most likely parsable inside the terminology service, but nothing can be assumed about its syntax outside that context.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CODE_PHRASE.code_string",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"isModifier" : false
},
{
"id" : "CODE_PHRASE.preferred-term",
"path" : "CODE_PHRASE.preferred_term",
"short" : "Optional attribute to carry preferred term corresponding to the code or expression in code_string",
"definition" : "Optional attribute to carry preferred term corresponding to the code or expression in code_string. Typical use in integration situations which create mappings, and representing data for which both a (non-preferred) actual term and a preferred term are both required.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CODE_PHRASE.preferred_term",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"isModifier" : false
}
]
},
"differential" : {
"element" : [
{
"id" : "CODE_PHRASE",
"path" : "CODE_PHRASE",
"short" : "A fully coordinated (i.e. all coordination has been performed) term from a terminology service",
"definition" : "A fully coordinated (i.e. all coordination has been performed) term from a terminology service (as distinct from a particular terminology).",
"min" : 0,
"max" : "*",
"isModifier" : false
},
{
"id" : "CODE_PHRASE.terminology-id",
"path" : "CODE_PHRASE.terminology_id",
"short" : "Identifier of the distinct terminology from which the code_string was extracted",
"definition" : "Identifier of the distinct terminology from which the code_string (or its elements) was extracted.",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "http://openehr.org/fhir/StructureDefinition/TERMINOLOGY-ID"
}
],
"isModifier" : false
},
{
"id" : "CODE_PHRASE.code-string",
"path" : "CODE_PHRASE.code_string",
"short" : "The key used by the terminology service to identify a concept or coordination of concepts",
"definition" : "The key used by the terminology service to identify a concept or coordination of concepts. This string is most likely parsable inside the terminology service, but nothing can be assumed about its syntax outside that context.",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "string"
}
],
"isModifier" : false
},
{
"id" : "CODE_PHRASE.preferred-term",
"path" : "CODE_PHRASE.preferred_term",
"short" : "Optional attribute to carry preferred term corresponding to the code or expression in code_string",
"definition" : "Optional attribute to carry preferred term corresponding to the code or expression in code_string. Typical use in integration situations which create mappings, and representing data for which both a (non-preferred) actual term and a preferred term are both required.",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "string"
}
],
"isModifier" : false
}
]
}
}
XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.